Skip to content

Fix links to the nixpkgs_package section in README #687

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
mox692 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix links to the nixpkgs_package section in README #687

mox692 wants to merge 1 commit into from

Conversation

@mox692
Copy link

@mox692 mox692 commented Dec 22, 2025

Looks like some links that are referencing to the nixpkgs_package section are using different section, this PR just updates them.

@mox692 mox692 requested a review from a team as a code owner December 22, 2025 12:13
@avdv
Copy link
Member

avdv commented Jan 26, 2026

Thank you for the PR, but the README is auto-generated with stardoc (it says so at the beginning of the file) and as far as I can tell the links are perfectly fine.

E.g. the docs for the build_fileattribute of nixpkgs_flake_package link to the build_file attribute of nixpkgs_package. So instead of duplicating the docs for an attribute, we just link to the same attribute of a similar rule which works similarly.

The only confusing part is probably that the link text only says rules_package instead of spelling out the attribute again. In order to fix this, you would have to edit the lines here:

rules_nixpkgs/core/nixpkgs.bzl

Lines 870 to 875 in cb0f9be

build_file: The file to use as the BUILD file for this repository. See [`nixpkgs_package`](#nixpkgs_package-build_file) for more information.
build_file_content: Like `build_file`, but a string of the contents instead of a file name. See [`nixpkgs_package`](#nixpkgs_package-build_file_content) for more information.
nixopts: Extra flags to pass when calling Nix. See [`nixpkgs_package`](#nixpkgs_package-nixopts) for more information.
quiet: Whether to hide the output of the Nix command.
fail_not_supported: If set to `True` (default) this rule will fail on platforms which do not support Nix (e.g. Windows). If set to `False` calling this rule will succeed but no output will be generated.
legacy_path_syntax: If set to True (not default), the Nix Flake invocation will directly call `nix build <path>` instead of `nix build path:<path>` which may involve copying the entirety of the Git repo into the Nix Store instead of just the path and its children.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@mox692 @avdv